home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / TUTORIALTOPIC.PY < prev    next >
Encoding:
Python Source  |  2000-06-29  |  8.8 KB  |  254 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85. import OFS.Folder
  86. from HelpSys.HelpTopic import TextTopic
  87. from Globals import HTML, HTMLFile, MessageDialog
  88. import DateTime
  89. import DocumentTemplate
  90. import StructuredText
  91. import string, re
  92.  
  93.  
  94. pre_pat=re.compile(r'<PRE>(.+?)</PRE>', re.DOTALL)
  95. tutorialExamplesFile='ZopeTutorialExamples.zexp'
  96.  
  97. class TutorialTopic(TextTopic):
  98.     """
  99.     A Tutorial Help Topic
  100.     """
  101.  
  102.     def __init__(self, id, title, text):
  103.         self.id=id
  104.         self.title=title
  105.         text=str(StructuredText.HTML(text))
  106.         self.obj=HTML(pre_pat.sub(clean_pre, text))
  107.         
  108.     index_html=HTMLFile('lessonView', globals())
  109.             
  110.     def lessonURL(self, id, REQUEST):
  111.         """
  112.         URL of the examples for a lesson
  113.         """
  114.         try:
  115.             return '%s/lesson%d' % (REQUEST['tutorialExamplesURL'], id)
  116.         except KeyError:
  117.             return ""
  118.             
  119.     def tutorialShowLesson(self, id, REQUEST):
  120.         """
  121.         Navigate management frame to a given lesson's screen.
  122.         """
  123.         url=self.lessonURL(id, REQUEST)
  124.         if not url:
  125.             return """\
  126. <p class="warning">
  127. Zope cannot find the tutorial examples.
  128. You should install the tutorial examples before
  129. continuing. Choose "Zope Tutorial" from the product
  130. add list in the Zope management screen to install
  131. the examples.
  132. </p>
  133. <p class="warning">
  134. If you have already installed the tutorial, you can either
  135. follow along manually, or reinstall the tutorial examples.
  136. Note: make sure that you have cookies turned on in your browser.
  137. </p>
  138. """
  139.         
  140.         return """\
  141. <SCRIPT LANGUAGE="javascript">
  142. <!--
  143. window.open("%s/manage_main", "manage_main");
  144. //-->
  145. </SCRIPT>
  146. <p class="information">
  147. <a href="%s/manage_main" target="manage_main"
  148. onClick="javascript:window.open('%s/manage_main', 'manage_main').focus()"
  149. >Show lesson examples</a> in another window.
  150. </p>""" % (url, url, url)
  151.  
  152.     def apiLink(self, klass, REQUEST):
  153.         """
  154.         Returns the URL to a API documentation for a given class.
  155.         """
  156.         names=string.split(klass, '.')
  157.         url="%s/Control_Panel/Products/%s/Help/%s.py#%s" % (REQUEST['SCRIPT_NAME'],
  158.                 names[0], names[1], names[2])
  159.         return '<a href="%s">API Documentation</a>' % url
  160.  
  161.     tutorialNavigation=HTMLFile('tutorialNav', globals())
  162.  
  163.  
  164. addTutorialForm=HTMLFile('tutorialAdd', globals())
  165.  
  166. def addTutorial(self, id, REQUEST=None, RESPONSE=None):
  167.     """
  168.     Install tutorial examples.
  169.     """
  170.     id=str(id)
  171.     ob=OFS.Folder.Folder()
  172.     ob.id=id
  173.     ob.title='Zope Tutorial Examples'
  174.     id=self._setObject(id, ob)
  175.     folder=getattr(self, id)
  176.  
  177.     # make sure that Gadfly is initialized
  178.     try:
  179.         from Products.ZGadflyDA.DA import data_sources
  180.         data_sources()
  181.     except:
  182.         raise 'Bad Request', 'The ZGadflyDA product must be installed!'
  183.  
  184.     # work around old Zope bug in importing
  185.     try:
  186.         folder.manage_importObject(tutorialExamplesFile)
  187.     except:
  188.         folder._p_jar=self.Destination()._p_jar
  189.         folder.manage_importObject(tutorialExamplesFile)
  190.  
  191.     # acquire REQUEST if necessary
  192.     if REQUEST is None:
  193.         REQUEST=self.REQUEST
  194.         
  195.     # Set local roles on examples
  196.     changeOwner(folder, REQUEST['AUTHENTICATED_USER'])
  197.  
  198.     # Run lesson setup methods -- call Setup.setup methods in lesson folders
  199.     examples=folder.examples
  200.     for lesson in examples.objectValues():
  201.         if hasattr(lesson, 'Setup'):
  202.             lesson.Setup.setup(lesson.Setup, REQUEST)
  203.  
  204.     if RESPONSE is not None:
  205.         e=(DateTime.DateTime('GMT') + 365).rfc822()
  206.         RESPONSE.setCookie('tutorialExamplesURL', folder.absolute_url() + '/examples',
  207.                 path='/',
  208.                 expires=e)
  209.         RESPONSE.redirect(folder.absolute_url() + '/examples')
  210.  
  211.  
  212. def changeOwner(obj, owner):
  213.     """
  214.     Recursively changes the Owner of an object and all its subobjects.
  215.     """
  216.     for user, roles in obj.get_local_roles():
  217.         if 'Owner' in roles:
  218.             obj.manage_delLocalRoles([user])
  219.             break    
  220.     obj.manage_setLocalRoles(owner.getUserName(), ['Owner'])
  221.     for subobj in obj.objectValues():
  222.         changeOwner(subobj, owner)
  223.         
  224. def clean_pre(match):
  225.     """
  226.     Reformat a pre tag to get rid of extra indentation
  227.     and extra blank lines.
  228.     """
  229.     lines=string.split(match.group(1), '\n')
  230.     nlines=[]
  231.  
  232.     min_indent=None
  233.     for line in lines:
  234.         indent=len(line) - len(string.lstrip(line))
  235.         if min_indent is None or indent < min_indent:
  236.             if string.strip(line):
  237.                 min_indent=indent   
  238.     for line in lines:
  239.         nlines.append(line[min_indent:])
  240.     
  241.     while 1:
  242.         if not string.strip(nlines[0]):
  243.             nlines.pop(0)
  244.         else:
  245.             break
  246.     
  247.     while 1:
  248.         if not string.strip(nlines[-1]):
  249.             nlines.pop()
  250.         else:
  251.             break
  252.     
  253.     return "<PRE>%s</PRE>" % string.join(nlines, '\n')
  254.